/*
 * Copyright 2020 The Backstage Authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import { JsonValue } from '@backstage/types';

export type ReadFileFunc = (path: string) => Promise<string>;

export interface TransformContext {
  dir?: string;
}

export type TransformFunc = (
  value: JsonValue,
  context: TransformContext,
) => Promise<
  | {
      applied: false;
    }
  | {
      applied: true;
      value: JsonValue | undefined;
      newDir?: string | undefined;
    }
>;
